Skip to content

[DOCS] Remove soft limit for snapshot repositories #80745

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 16, 2021
Merged

[DOCS] Remove soft limit for snapshot repositories #80745

merged 5 commits into from
Nov 16, 2021

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Nov 15, 2021

As part of #74350, snapshot repositories no longer have a 200 snapshot soft limit. This removes docs related to the limit from 7.14+ branches.

cc @Leaf-Lin

@jrodewig jrodewig changed the title [DOCS] Remove 200 snapshot soft limit for repo [DOCS] Remove soft limit for snapshot repositories Nov 15, 2021
@jrodewig jrodewig added the :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs label Nov 15, 2021
Comment on lines -275 to -278
While not a hard limit, a snapshot repository shouldn't contain more than
{max-snapshot-count} snapshots at a time. This ensures the repository's metadata
doesn't grow to a size that may destabilize the master node. We recommend you
set up your {slm-init} policy's retention rules to enforce this limit.
Copy link
Contributor Author

@jrodewig jrodewig Nov 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@original-brownbear Let me know if we want to offer any guidance to users for sizing their snapshot repositories. I can also use this information to update the policy UI copy in Kibana.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say we shouldn't give a hard number here these days probably. Maybe we should just point out that the repository does scale to thousands of snapshots, but that larger repositories do require more memory/a larger master. Just to make it clear that people should have retention setup in SLM and can't outright run a snapshot every 5 minutes for the next 10 years without ever deleting anything?
As long as we at least make it clear that there are limits and master node costs here and that deletes are necessary eventually we're good I think.

Copy link
Contributor Author

@jrodewig jrodewig Nov 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I re-added some guidance based on your comment with 521dbb8. Let me know what you think.

If that looks good to you, I'll merge this and get a fix open for the Kibana UI.

@jrodewig jrodewig marked this pull request as ready for review November 15, 2021 22:49
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. labels Nov 15, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)

Copy link
Member

@original-brownbear original-brownbear left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM just the -"disk space" :) Thanks @jrodewig !

snapshots you no longer need.

A snapshot repository can safely scale to thousands of snapshots. However, to
manage its metadata, a large repository requires more memory and disk space on
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"disk space" is not true, sorry that was my unfortunate wording above. It's really just memory that's the limiting factor here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the correction.

@jrodewig jrodewig merged commit a480603 into elastic:master Nov 16, 2021
@jrodewig jrodewig deleted the docs__remove-200-snapshot-soft-limit branch November 16, 2021 17:24
elasticsearchmachine pushed a commit that referenced this pull request Nov 16, 2021
As part of #74350, snapshot repositories no longer have a 200 snapshot soft limit. This removes docs related to the limit.
elasticsearchmachine pushed a commit that referenced this pull request Nov 16, 2021
As part of #74350, snapshot repositories no longer have a 200 snapshot soft limit. This removes docs related to the limit.
elasticsearchmachine pushed a commit that referenced this pull request Nov 16, 2021
As part of #74350, snapshot repositories no longer have a 200 snapshot soft limit. This removes docs related to the limit.
# Conflicts:
#	docs/reference/slm/apis/slm-put.asciidoc
#	docs/reference/snapshot-restore/take-snapshot.asciidoc
elasticsearchmachine pushed a commit that referenced this pull request Nov 16, 2021
As part of #74350, snapshot repositories no longer have a 200 snapshot soft limit. This removes docs related to the limit.
# Conflicts:
#	docs/reference/slm/apis/slm-put.asciidoc
#	docs/reference/snapshot-restore/take-snapshot.asciidoc
jrodewig added a commit to elastic/kibana that referenced this pull request Nov 17, 2021
With elastic/elasticsearch#74350, we no longer recommend a 200 snapshot soft limit for snapshot repositories or SLM policies. This removes a related sentence from the Snapshot Policy UI.

It also updates the docs link to point to the [create snapshot docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshots-take-snapshot.html), which include guidance on snapshot retention, rather than the [put SLM policy API docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-put-policy.html).

Relates to elastic/elasticsearch#80745
jrodewig added a commit to elastic/kibana that referenced this pull request Nov 17, 2021
With elastic/elasticsearch#74350, we no longer recommend a 200 snapshot soft limit for snapshot repositories or SLM policies. This removes a related sentence from the Snapshot Policy UI.

It also updates the docs link to point to the [create snapshot docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshots-take-snapshot.html), which include guidance on snapshot retention, rather than the [put SLM policy API docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-put-policy.html).

Relates to elastic/elasticsearch#80745
jrodewig added a commit to elastic/kibana that referenced this pull request Nov 17, 2021
With elastic/elasticsearch#74350, we no longer recommend a 200 snapshot soft limit for snapshot repositories or SLM policies. This removes a related sentence from the Snapshot Policy UI.

It also updates the docs link to point to the [create snapshot docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshots-take-snapshot.html), which include guidance on snapshot retention, rather than the [put SLM policy API docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-put-policy.html).

Relates to elastic/elasticsearch#80745
TinLe pushed a commit to TinLe/kibana that referenced this pull request Nov 20, 2021
With elastic/elasticsearch#74350, we no longer recommend a 200 snapshot soft limit for snapshot repositories or SLM policies. This removes a related sentence from the Snapshot Policy UI.

It also updates the docs link to point to the [create snapshot docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshots-take-snapshot.html), which include guidance on snapshot retention, rather than the [put SLM policy API docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-put-policy.html).

Relates to elastic/elasticsearch#80745
dmlemeshko pushed a commit to elastic/kibana that referenced this pull request Nov 29, 2021
With elastic/elasticsearch#74350, we no longer recommend a 200 snapshot soft limit for snapshot repositories or SLM policies. This removes a related sentence from the Snapshot Policy UI.

It also updates the docs link to point to the [create snapshot docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshots-take-snapshot.html), which include guidance on snapshot retention, rather than the [put SLM policy API docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-put-policy.html).

Relates to elastic/elasticsearch#80745
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team v7.14.3 v7.15.3 v7.16.0 v8.0.0-beta1 v8.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants